/*
 * Copyright 2002-2006 the original author or authors. Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions and limitations under the
 * License.
 */
package pikes.html.xhtml.heading;

import java.util.LinkedList;
import java.util.List;

import pikes.html.xhtml.Block;
import pikes.html.xhtml.CoreAttributes;
import pikes.html.xhtml.Events;
import pikes.html.xhtml.I18N;
import pikes.html.xhtml.Inline;
import pikes.html.xhtml.InlineList;
import pikes.html.xhtml.NonRootTagFactory;
import pikes.html.xhtml.PCData;
import pikes.xml.XMLTag;

/**
 * Abstract heading element, see <a href="http://www.w3.org/TR/html401/struct/global.html#h-7.5.5">heading elements</a>
 * in HTML specification.
 * @author Peter Bona
 * @see <a href="http://www.w3.org/TR/html401/struct/global.html#h-7.5.5">The heading elements in HTML specification</a>
 */
public abstract class Heading extends NonRootTagFactory implements Block, CoreAttributes, I18N, Events, InlineList {

	private List<Inline> inlines = new LinkedList<Inline>();

	protected Heading() {
		// left intentionally empty, by default it does nothing
	}

	protected Heading(List<Inline> inlines) {
		if (inlines != null) {
			this.inlines = inlines;
		}
	}

	protected Heading(Inline inline) {
		if (inline != null) {
			inlines.add(inline);
		}
	}

	protected Heading(CharSequence text) {
		if (text != null) {
			inlines.add(new PCData(text));
		}
	}

	@Override
	protected CharSequence getTagName() {
		return "h" + Integer.toString(getLevel());
	}

	protected abstract int getLevel();

	/*
	 * (non-Javadoc)
	 * @see org.pikes.html.xhtml.InlineList#add(org.pikes.html.xhtml.Inline)
	 */
	public void add(Inline inline) {
		if (inline != null) {
			inlines.add(inline);
		}
	}

	public void add(CharSequence text) {
		if (text != null) {
			inlines.add(new PCData(text));
		}
	}

	@Override
	protected void decorateCreatedTag(XMLTag tag) {

		for (Inline inline : inlines) {
			inline.decorateTag(tag);
		}
	}
}
